home *** CD-ROM | disk | FTP | other *** search
/ L' Effet Pommier 3 / L'Effet Pommier - Volume 03.iso / Programmation / Alpha ƒ / Help / Manual < prev    next >
Text File  |  1996-01-23  |  69KB  |  1,577 lines
  1.            Copyright ⌐ 1990-1996 Pete Keleher. All Rights Reserved
  2.  
  3. The Author(s) of this product are in no way liable for any direct or 
  4. indirect damage caused by the product. 
  5.  
  6. You may freely copy and distribute ALPHA, but please bear in mind that 
  7. ALPHA is Shareware.  If you decide to keep it, please register your copy 
  8. by selecting 'Register' from the 'About╔' dialog.
  9.  
  10. I am collecting user-written Tcl procs cs.umd.edu.  If you have written 
  11. anything that you think may be of general interest, please send it to me 
  12. and I will make it available.
  13.  
  14. Alpha contains source from main places, but in particular I'm grateful to 
  15. Ray Johnson and Tim Endres for their working on porting TCL to the mac, and 
  16. to Tom Scavo and Tom Pollard for their Tcl code contributions.  The 
  17. following people have also provided considerable code and/or help debugging 
  18. the one or two bugs Alpha has had: Masatsugu Nagata, Karl J. Smith, Eric 
  19. Sink, David C. Black, Richard T. Austin, Henry Spencer, Vince Darley, and 
  20. Jerry Fowler.
  21.  
  22. What to do: USE THE MARKS MENU IN THIS FILE!.  This file contains "marks" 
  23. in a popup menu above the vertical scrollbar on the right, that let you 
  24. jump to different sections of this file.  Mouse-down on the curly braces.
  25.  
  26. Also, Alpha supports a limited form of hypertext. Clicking on green 
  27. underlined text executes a command associated with the underlined text, 
  28. usually taking you to other documentation. Control-<period> will bring you 
  29. back.  For example, clicking here takes you to more documentation of the 
  30. hypertext capabilities.  
  31.  
  32. Alpha's hypertext links can be used to perform arbitrary tasks, including 
  33. interaction with other applications.  Once you have Internet Config 
  34. installed, the following links will all be active:
  35.     Alpha's home site:        click here (or here if no Internet Config)
  36.     Mail to the author:        click here
  37.     
  38.  
  39. Alpha is a very powerful, multi-purpose editor that allows any program- 
  40. or user-defined function to be bound to any keystroke, or placed into 
  41. user-defined menus. Every menu is defined in the macro language Tcl by 
  42. one of the startup files ("alphaBits.tcl" or one of the files sourced 
  43. from inside it). 
  44.  
  45. Alpha uses Dr.  Ousterhout's Tool Command Language (Tcl) as an extension 
  46. language.  Click here for a more complete definition of the language.  Many 
  47. of the functions bound to keystrokes, as well as many of the functions in 
  48. the user-defined menus, are written in Tcl.
  49.  
  50. Callable functions in Alpha come in two different flavors.  First, there 
  51. are the basic Tcl commands, detailed here.  Second there are "Alpha commands",
  52. commands that relate specifically to Alpha. 
  53.  
  54. The only way to get to know the editor and the language is to try different 
  55. things out.  Play around.  Choose the menu item "Misc:List Bindings" to get 
  56. a listing of all the current keystoke bindings.  Look in "procs.tcl" for 
  57. definitions of many of the routines.  Look in "menus.tcl" for 
  58. definitions of most of the menus.  See the section on "GUI Details" for 
  59. more information about the various pieces of Alpha's windows. And 
  60. finally, please feel free to send suggestions/"feature" reports/questions 
  61. to me at keleher@cs.umd.edu.  I am not able to answer US postal mail, but 
  62. if you send it to me I will at least read it.  Have fun!
  63.  
  64.  
  65.  
  66.           GUI Details
  67.  
  68. Alpha's interface has several non-standard features. First, there is a status 
  69. window across the bottom of the primary window.
  70.  
  71. Second, the horizontal scrollbar can be turned on and off via the window 
  72. menu. The default for subsequent windows is controlled via the 
  73. global variable horScrollBar (look under "Modes:Flags").
  74.  
  75. Third, above the vertical scrollbar on the right is at least one
  76. icon.  The icon w/ the curly braces ('{}') is the "Marks" menu, which
  77. lists all marks for the current window and allows them to be cleared or 
  78. automatically created (through the Tcl proc 'markFile' that calls 
  79. mode-specific routines).  Above this icon, a red disk icon appears 
  80. if the window is currently dirty.  Clicking on this icon saves the file.
  81.  
  82. Directly above the vertical scrollbar is a black bar that can be used to 
  83. split any window into two independent panes showing the same buffer. 
  84. Windows are split by either dragging the black bar or using the 
  85. "Windows:Split Window" menu command. Windows are unsplit the same way. 
  86. Double-clicking on the bar can also be used to toggle whether the window 
  87. is split.
  88.  
  89. Command-clicking on the window name brings up a popup menu that shows the 
  90. complete pathname of the file.  Command-clicking anywhere else on the 
  91. titlebar brings up the mark menu. Option-clicking on the titlebar of a 
  92. window queries the Symantec project manager for include files, if 
  93. running. 
  94.  
  95. Option-clicking and dragging text enables rectangular editing.
  96.  
  97. Control-double-clicking on any type of paren or bracket hilites from the 
  98. paren or bracket to its mate.  Without the control key held down, only the 
  99. intervening text is selected.
  100.  
  101. Command-clicking on a selection passes it to the Internet Config app.
  102.  
  103. Cmd-double-clicking in *any* mode will attempt to open a URL in the 
  104. surrounding text and send it to your web browser. If this fails, Alpha then 
  105. tries a mode-specific procedure.
  106.  
  107. Command-double clicking on a word in a C file will try to find the 
  108. definition of the word. The first option is looking up the word in the 
  109. tag file. If the word is not a tag, or no tags have been specified, Alpha 
  110. attempts to lookup the word through the THINK Reference app. If you would like 
  111. Apple's Toolbox Assistant to be used instead, edit the proc 
  112. 'cmdDoubleClick'. In Tcl mode, the verb is looked up in the SystemCode 
  113. and UserCode directories, then in ":Help:Alpha Commands", and then 
  114. finally in ":Help:Tcl Commands".
  115.  
  116. Alpha also supports drag and drop editing.
  117.  
  118. The grow region in the lower right corner is replaced by a lock icon if the 
  119. file is read-only.  Read-only status can be changed by command-clicking in 
  120. this area.
  121.  
  122. See "Status Bar" for information describing the bar running across the 
  123. bottom of the screen.
  124.  
  125.  
  126.           Searches
  127.  
  128. ALPHA has a full repertoire of searching commands.  The 'find' command 
  129. brings up a dialog allowing the search and replacement text to be 
  130. specified.  The dialog also allows 'Forward', 'Ignore Case', 'Reg Expr', 
  131. and 'Word Match' options to be set.  These options can be toggled via the 
  132. keyboard by clover-<first letter of option>.  For example, clover-w toggles 
  133. the 'Word Match' option.
  134.  
  135. The 'Mult Files' option tells Alpha to search through all files in a given 
  136. file set.  Filesets can be specified in 'procs.tcl' (see the section on 
  137. filesets) or on the fly, via the "Create Fileset╔" item of the "File 
  138. Sets:Utilities" sub-menu. Filesets can be chosen via the popup fileset menu.
  139.  
  140. In addition to the current filesets, the fileset menu has an entry called 
  141. "Directory Scan". Selecting this menu item enables the "Scan Options" 
  142. button. This button, in turn, allows the specification of a directory and 
  143. a file pattern to be searched instead of a fileset. To set the directory, 
  144. hit the "Dir:" button. The pattern is used to select files of the 
  145. selected directory. The '*' wildcard character can be used to replace any 
  146. sequence of characters. For example, the pattern '*.c' will select any 
  147. file ending with ".c". If this doesn't work, be sure that you executed 
  148. all of the following steps:
  149.         1) select "Directory Scan" in the popup menu of the find dialog
  150.         2) Hit the "Scan Options" button.
  151.         3) Select a directory via the "Dir:" button.
  152.  
  153. All multiple searches can be "Batch" searches, a list of all matches in the 
  154. fileset are displayed in a new window.  A particular match can be displayed 
  155. by moving the cursor to a line in the file of matches and selecting "Goto 
  156. Match" from the Utils menu (also bound to control-c control-c).
  157.  
  158. And finally, Alpha allows a library of useful search and replace texts to 
  159. be defined as a tcl list of lists (each sublist containing a name, search 
  160. text, and replacement text). This list, the 'patternLibrary' variable 
  161. defined at the end of 'procs.tcl', is used to create a popup menu in the 
  162. find dialog allowing these patterns to be easily entered.
  163.  
  164. Once the text and options have been set, the 'Search' menu contains several 
  165. commands for repeated searching, replacing, etc. 
  166.  
  167.  
  168.           Regular Expressions
  169.  
  170. If the variable 'regExpr' is true, the search functions interpret the 
  171. search text as regular expressions, which have the following elements:
  172.  
  173.  c        literal char.
  174.  ^        beginning of line.
  175.  $        end of line.
  176.  .        any character except carriage return.
  177.  [...]    character class, can use ranges such as '0-9'.
  178.           inside classes. Matches one character of the 
  179.           enclosed choices. Ex: '[ac0-2]' matches 'a', 
  180.           'c', '0', '1', or '2'.
  181.  [^...]   negated character class, matches anything but
  182.           the enclosed characters. ']' can be included
  183.           by putting it immediately after the '^'.
  184.  \t       tab.
  185.  \r       carriage return or line break.
  186.  *        zero or more occurrences of the previous
  187.           pattern. Ex: 'ab*' matches 'a', 'ab', 'abb',
  188.           'abbb' etc.
  189.  +        one or more occurrences of the previous 
  190.           pattern. 
  191.  ?        zero or one occurrences of the previous 
  192.           pattern. Ex: 'ab?' matches 'a' or 'ab'.
  193.  a|b      matches either a or b. If enclosed in
  194.           parenthesis, the extent of the alternated
  195.           expressions is limited. Ex: (pete|bob) 
  196.           matches either 'pete' or 'bob'.
  197.  (...)    The interior elements are grouped together. 
  198.  
  199. Regular expressions constructed from the above elements can be 
  200. concatenated to create larger expressions. 
  201.  
  202. The parenthesis also define substrings of the total matched string that 
  203. can be used either later during substitution. The substring delimited by 
  204. the pair of parenthesis that includes the nth left paren is denoted \n, 
  205. where n is 1, 2, .... 9.  '\0' and '&' both refer to the matched text.
  206.  
  207. EXAMPLE: 
  208. The following regular expression will match either 'aabox' or 'bbbox':
  209.  
  210.               (aa|bb)box
  211.  
  212. See here for more details.  Regular expressions can be very difficult to 
  213. master, but they the following section shows how useful they can be.
  214.  
  215.  
  216.  
  217.           Searches, Incremental
  218.  
  219. Emacs users will be happy that both forward and backward incremental 
  220. searches are implemented. Incremental searches bypass the normal search 
  221. dialog and search for the current text after each keystroke. The result is 
  222. often much faster and less intrusive. Executing either while an incremental 
  223. search is in progress causes the search to proceed to the next instance of 
  224. the current text. Incremental search mode is exited when any other command 
  225. (executed through the menus or through bindings that include at least one of 
  226. the control key and the option key) is executed, or when the escape or 
  227. delete key is used. Typing control-w while incremental search is active 
  228. causes all the characters to the end of the next word boundary to be 
  229. added to the search.
  230.  
  231.  
  232.           Marks
  233.  
  234. Alpha allows the user to use "marks" to remember positions in files. Marks 
  235. "float". That is, if a mark is initially at position 312 and then five 
  236. characters are inserted at location 297, the mark's new value will be 317. 
  237. Alpha uses three different types of marks. 
  238.  
  239. The first is generically referred to as "the mark". The mark is set to the 
  240. current insertion point by the command 'setMark' (control-space by 
  241. default). The position in the file indicated by the blinking cursor is 
  242. referred to as the current insertion point. Many commands (such as "cut" 
  243. and "copy") can operate either on the currently selected (hilighted) text, 
  244. or the text between the current insertion point and "the mark". For 
  245. example, if you move the cursor to the beginning of the work "allybaba", 
  246. hit control-space (the status bar should say "Mark set"), move to the end 
  247. of the word and hit option-w (the status bar should say "Region copied"), 
  248. the effect is the same as if you had used the mouse to select the text and 
  249. then selected the "Copy" command from the "Edit" menu.
  250.  
  251. The second type of mark are the permanent marks. Permanent marks are set, 
  252. removed, and moved-to through the three corresponding menu items in the 
  253. "Search" menu. Permanent marks differ from the generic mark in that they 
  254. have names, there can be any number of them, and they are saved in the 
  255. resource fork if the file is subsequently saved.
  256.  
  257. Permanent marks can be access via the "Search:Named Marks" menu items, by 
  258. a popup menu called by mousing down on the curly braces above a vertical 
  259. scrollbar, or by command-mousing on a window's titlebar.
  260.  
  261. The third type of mark is the temporary mark. Like permanent marks, 
  262. temporary marks can be named and there can be any number of them. Unlike 
  263. permanent marks, temporary marks do not "dirty" the file, and they aren't 
  264. saved. So far, temporary marks are used exclusively to implement higher 
  265. order functions in TCL procedures. In the 5.0 release, temporary marks are 
  266. used to implement a "mark stack" and a for loop template.
  267.  
  268. At the time a file is saved, the marks for that file are stored into the 
  269. file's resource fork in an order determined by the variable 
  270. 'markSorting'. The choices are either 0 (no sorting), 1 (sort by file 
  271. position), or 2 (sort alphabetically).
  272.  
  273.  
  274.  
  275.  
  276.           Colorizing
  277.  
  278. Version 5.80 and up support automatic "colorizing" of text.  This is 
  279. controlled by the function 'regModeKeywords', which registers keywords to 
  280. colorize in a specific mode.  By default, color schemes are supplied for C, 
  281. C++, Pascal, Tcl, and TeX.  Colorizing can be turned off via the 'coloring' 
  282. flag.
  283.  
  284. You can add words to a given mode by creating a file called prefs.tcl 
  285. in the 'Alpha' subdirectory of the system preferences file, and using 
  286. regModeKeywords w/ the -a option.
  287.  
  288. Additionally, versions 6.02 and above allow the text color and window 
  289. background to be changed.  These are changed by redefining 'ForeGround' and 
  290. 'BackGround' in the "Config:Redefine Colors" menu.  The menu also allows all 
  291. eight of the primary colors to be redefined as well.  For instance, you can 
  292. redefine 'red', and any text that is currently red will then be the new 
  293. color you specify.  Finally, there are eight other colors 'Color_9' through 
  294. 'Color_15' that can be used though regModeKeywords etc, and values for 
  295. these can be redefined as well.
  296.  
  297.  
  298.           File Detritus
  299.  
  300. The primary method of either reading or storing files with Alpha, or any 
  301. other Mac editor, is through the GetFile and PutFile dialogs. However, 
  302. Alpha's dialogs are not exactly like those of other applications. 
  303.  
  304. The GetFile dialog has two additional items: a "Read-only" checkbox and an 
  305. "All Files" checkbox.  The first allows you to open a file as read only.  
  306. Files in the read-only state can not be modified, only read.  A read-only 
  307. file is indicated by a lock icon replacing the grow zone icon.  Read-only 
  308. status can be toggled by command-clicking on the icon. The default action for 
  309. 'space' and 'backspace' when a file is read-only is to page forward 
  310. (closing at the bottom of the file) or backward.
  311.  
  312. The second checkbox, "All Files", allows Alpha to open any file rather 
  313. than just those of type 'TEXT'. The type of a file can be determined by 
  314. using the 'll' alias in the Tcl shell.
  315.  
  316.  
  317. The PutFile dialog is used to prompt the user for a new name under which to 
  318. save the contents of a window. This dialog has been enhanced by two popup 
  319. menus: "State" and "Format". "State" allows you to specify how much 
  320. information should be saved in the resource fork of files that you use. If 
  321. the state is set to "MPW", window position, current selection, tab sizes, 
  322. and font information are saved into the resource fork of your application 
  323. every time you open and close it, *even if you don't modify the file*. 
  324. Alpha still manages to coexist with build or make files because saving this 
  325. information does not change the modification date of the file. If the state 
  326. is set to "Think", neither the window position nor the current selection 
  327. are saved. If state is set to "None", no information is saved. The default 
  328. value for saved state can by changed by setting the Alpha variable 
  329. 'savedState' to "mpw", "think", or "none". Note that if a given file 
  330. already has mpw information in it when the file is open, Alpha will always 
  331. update that information when the file is closed. Note also that "marks" 
  332. are always saved in the resource fork whenever a file is saved, 
  333. regardless of the setting of the 'savedState' variable.
  334.  
  335. The "Format" menus allows the way Alpha terminates lines to be changed. 
  336. The Mac uses a carriage return to mark the end of a line, Unix uses a 
  337. linefeed, and IBM uses both (of course). Alpha can read and write any of 
  338. these formats, and can convert between them just by opening a file, 
  339. choosing "Save As", and changing the selection in this menu. Note that if 
  340. you are going to be sharing files with a Unix or IBM machine, you 
  341. probably don't want anything in your resource fork, so you'd probably 
  342. want to set 'savedState' to 'none' in your prefs.tcl file.
  343.  
  344.  
  345.           Menus
  346.  
  347. Alpha's menus are completely reconfigurable. Some of the menu items are 
  348. internal alpha commands, while others are Tcl procs defined in one of the 
  349. files of the "Tcl" subdirectory. Most of these procs are defined in 
  350. "procs.tcl". The following is an explanation of the default menus. The 
  351. explanations of items that are defined as Tcl procs are implemented by the 
  352. Tcl proc specified by "(proc <name>)", and can be found in one of the .tcl 
  353. files. All others are internal functions. 
  354.  
  355. Versions 5.98 and above use Ramon Felciano's Mercury MDEF to display 
  356. menus. In addition to allowing other modifiers to be shown in the menu, 
  357. this MDEF also allows alternates, items that change depending on the 
  358. state of the modifier keys. Alternate items are tagged below by the 
  359. modifier that must be depressed to display it.
  360.  
  361. File
  362.     New                      New file.
  363.     Open╔                   Open file.
  364.     Recent╔                    Menu of recently opened files. These same files
  365.                             can be opened via the 'editFile' (cmd-') proc
  366.                             from the submenu of the filesets menu.
  367.     Close                   Close file.
  368.     Close All (option)        Close all files.
  369.  
  370.     Save                       Save file.
  371.     Save All (option)        Save all files.
  372.     SaveAs╔                   Prompt for name to same file under.
  373.     Revert                   Revert to last saved version, throw away undo history. 
  374.     Revert To Backup (option) Revert to last backup copy, if any.
  375.         
  376.     Shell                   Start up command-line shell that interprets Tcl 
  377.                             commands. The shell has a few csh-type features, 
  378.                             such as 'ls', 'rm', etc. commands, as well as file 
  379.                             completion with the TAB key. 
  380.  
  381.     Page Setup╔               Set print options.
  382.     Print                  
  383.         Print╔                Print file directly.
  384.         
  385.         Kodex C Pretty Printer        Print through Kodex app.
  386.         Enscriptor Fancy Printer    Print through Enscriptor app.
  387.         Send PS to 'DropÑPS'        Print through 'DropÑPS' app.
  388.         
  389.     Print All╔    (option)    Print all files.
  390.  
  391.     Quit                       Quit Alpha.
  392.  
  393. Edit
  394.     Undo                    Undo. 
  395.     Redo (option)            Redo. 
  396.     Load                    Execute either the window or the selection as Tcl 
  397.                             source. 
  398.     Cut                        Cut selection to scrap.
  399.     Cut & Append (option)    Cut and append selection to scrap.
  400.     Copy                    Copy selection to scrap.
  401.     Copy & Append (option)    Copy and append selection to scrap.
  402.     Paste                    Paste from scrap.
  403.     Paste Pop (option)        Immediately after a paste, use a previous paste 
  404.                             instead.
  405.     Yank                    Paste last deleted text. Concatenates together 
  406.                             consecutive, adjoining deletions.
  407.  
  408.     Emacs                    Lots of Emacs key bindings.
  409.     Twiddle                    Exchange characters bracketing the selection point.
  410.     Twiddle Words (option)    Exchange words bracketing the selection point.
  411.     Select All                Select entire file.
  412.     Select Paragraph (option)    Select current paragraph.
  413.     Clear                    Delete selection.
  414.  
  415.     Shift Left                Shift selection left one tab.
  416.     Shift Left Space (option)    Shift selection left one space.
  417.     Shift Right                Shift selection right one tab.
  418.     Shift Right Space (option)    Shift selection right one space.
  419.     Balance                    Select text out to the next set of matching braces.
  420.  
  421. Text
  422.     Fill Paragraph            "Fill" paragraph that contains the insertion (proc 
  423.                             fillParagraph).
  424.     Wrap Paragraph (option)    Break lines longer than 'fillColumn' in paragraph 
  425.                             containing insertion pt (proc wrapParagraph).
  426.     Fill Region                "Fill" selection subject to 'leftFillColumn' and 
  427.                             'fillColumn', (proc fillRegion).
  428.     Wrap Region (option)    Break lines longer than 'fillColumn' in selection 
  429.                             (proc wrapRegion).
  430.  
  431.     Sort Lines                Sort selected lines (proc sortLines).
  432.     Spellcheck Window
  433.  
  434.     Zap Invisibles            Delete all chars in file w/ ASCII code < 32, except 
  435.                             for LF, TAB and CR.
  436.     Tabs To Spaces            Convert tabs to space runs.
  437.     Spaces To Tabs            Convert space runs to tabs.
  438.  
  439.     Strings
  440.         Insert Prefix            Prepend string 'prefixString' to every line in 
  441.                                 selection (proc insertPrefix).
  442.         Remove Prefix (option)    Remove prefix string from lines in selection 
  443.                                 (proc removePrefix). 
  444.         Insert Suffix            Append string 'suffixString' to every line in 
  445.                                 selection (proc insertSuffix).
  446.         Remove Suffix (option)    Remove suffix string from lines in selection 
  447.                                 (proc removeSuffix). 
  448.         Set Prefix╔                Change prefix string (proc setPrefix).
  449.         Set Suffix╔                Change suffix string (proc setSuffix).
  450.     Comment Line            Comment out line, considering mode.
  451.     Uncomment Line (option)    Un-comment line, considering mode.
  452.     Comment Box                Create a comment box around selected text.
  453.     UnComment Box (option)    Remove such a comment box.
  454.     Comment Paragraph        Comment out a paragraph.
  455.     Uncomment Paragraph        Uncomment a paragraph.
  456.     Downcase Region            Downcase all chars in region.
  457.     Upcase Region            Upcase all chars in region.
  458.  
  459.     Select Last                Select text last manipulated, such as from a paste.
  460.     Named Marks
  461.         Set╔
  462.         Goto╔
  463.         Remove╔
  464.     Unnamed Marks
  465.         Set╔
  466.         Exchange Point and Mark
  467.  
  468. Search
  469.     Find╔                    Present a search dialog.
  470.     Search Start (option)    Return selection point to where the last search 
  471.                             started. 
  472.     Find Again                Search forward again w/ same settings.
  473.     Find Again Backward (option)    Search backward again w/ same settings.
  474.     Find in Next File        Restart multiple-file search in next file after 
  475.                             stopping at a match.
  476.     Enter Search String        Use the current selection as the search text.
  477.     Enter Replace String (option)    Use the current selection as replace text.
  478.  
  479.     Quick Find                Incremental search forward (grep, match words off, 
  480.                             ignore case on). Type chars to define string, 
  481.                             control-w adds the current word to the search
  482.                             string, control-s/r search for the same string again.
  483.     Reverse Quick Find        Same think in reverse.
  484.     
  485.     Replace                    Replace the selection.
  486.     Replace and Find Again    Replace the selection and search again forward.
  487.     Replace All (option)    Replace all of occurances of the search string 
  488.                             in the rest of the file.
  489.     Replace in Fileset (control)    Global replace in fileset.
  490.     
  491.     Push Position            Push current pos onto a "stack".
  492.     Pop Position            Pop last pos from stack and go to it.
  493.     Goto Line                Goto specific line number.
  494.     
  495. Utils
  496.     File Utils
  497.         Insert Path Name╔    Prompt for a file and insert complete pathname in 
  498.                             window.
  499.         Insert File╔        Insert the text of another file.
  500.         File Remove╔        Remove a file.
  501.         File Info╔            Display/edit info about a file.
  502.         Word Count            Count lines, words, chars in window (proc wordCount).
  503.     Compare
  504.         Windows                Compare top two windows, sending output to a third. 
  505.                             Selecting a line in the third window and hitting 
  506.                             return (or enter) moves that line to the top of 
  507.                             the window.
  508.         Files                Same as above, but prompts for files.
  509.         Directories            As above, but works for entire directories. 
  510.     Ascii Etc
  511.         Key Code╔            Wait for key press and insert keycode and modifier 
  512.                             string suitable for key binding.
  513.         Key Ascii╔            Same as above, but use ascii form.
  514.         Get Ascii╔            Display ascii code for char to right of insertion.
  515.         Insert Ascii╔        Prompt for ascii code and insert character.
  516.         .....                Many emacs movement commands.
  517.     Kbd Macros
  518.         Start Keyboard Macro    Start creating anonymous macro.
  519.         End Keyboard Macro        Finish.
  520.         Execute Keyboard Macro    Execute.
  521.         Dump Macro                Dump to current file.
  522.  
  523.     Switch To                Bring other apps to front.
  524.     Internet Config            Start internet applications.
  525.     Send URL                Send selection as URL to proper internet app.
  526.     
  527.     Matching Lines            Find all lines that match a regular expression and 
  528.                             summarize in new window. (proc matchingLines). 
  529.     Goto Match                Jump to the original text specified by the current 
  530.                             line in a "Batch Find" or "Matching Lines" window.
  531.     Next Match                Next match.
  532.                                 
  533.     Cmd-Double Click        Look up and display definition of the selected 
  534.                             word. If in "C" or "C++" mode, use the file pointed 
  535.                             to by 'tagFile'. If in "Tcl" or "Shel" mode, look
  536.                             in "Alpha Commands", "Tcl Commands", and the "Tcl"
  537.                             subdirectory.
  538.                             
  539. Config
  540.     Current Mode            
  541.         Menus╔                Change current mode's menus.
  542.         Flags╔                Change options for current mode.
  543.         Edit Prefs            Edit mode-specific preferences.  Loaded 
  544.                             after mode entered for the first time.
  545.         Source Prefs        Load current mode's preferences.
  546.         Describe            Describe current mode's variable settings and 
  547.                             bindings.
  548.     Global
  549.         Flags                Global variables.
  550.             ...                
  551.         Edit prefs            Put your own arbitrary startup code here (used to be 
  552.                             "userStartup.tcl"). Loaded after all standard Tcl 
  553.                             code. 
  554.         Describe Binding╔    Wait for a keystroke, then display that keystroke's 
  555.                             binding.
  556.         List Bindings        Create a new file containing all current key bindings.
  557.         List Functions        List all functions currently defined, both
  558.                             "core" functions (those coded in C), and those
  559.                             coded in the supplied Tcl files.
  560.     View Saved Settings╔     Any variables or flags that you modify during
  561.                             the course of a session are saved to files in the 
  562.                             system preferences folder when Alpha quits. 
  563.                             This function shows all such saved variables.
  564.     Remove Saved Settings╔    This function allows settings to be removed.
  565.     
  566.     App Paths                List of paths to other applications. Allows 
  567.                             paths to be viewed, changed, set from Internet Config 
  568.                             or reset.
  569.     Install
  570.         Electric Alias        Loads David Black's "electric alias" routines, see 
  571.                             the appropriate help file.
  572.         Mac Perl            Permanently loads the Tom Pollard's perl mode.
  573.         HTML                Permanently loads the Scott Brim's HTML mode.
  574.  
  575.  
  576.     Set Font Tabs╔            Change font and/or tabs for current file.
  577.     Redefine Colors╔        See Colorizing.
  578.             
  579. Wins (an icon with three windows)
  580.     Zoom                    Zoom windows in and out.
  581.     Single Page (option)    Resize as single page.
  582.     Choose A Window            Choose window to select from list (proc 
  583.                             chooseAWindow).
  584.     Iconify                    Toggle iconification of front window.
  585.     Arrange                    Rearrange open windows.
  586.  
  587.     Split Window            Split window into two panes, or unsplit.
  588.     Toggle Scrollbar        Toggle the horizontal scrollbar on the frontmost 
  589.                             window. The scrollbar can be enabled/disabled on 
  590.                             subsequent variables by changing the value of 
  591.                             the 'horScrollBar' flag.
  592.  
  593. File Sets            
  594.         Edit File            Edit a file from one of the filesets.
  595.  
  596.         (hierarchical menus containing fileset and their files, select file to 
  597.          edit)
  598.  
  599.         Utilities
  600.             Choose                Set current fileset.
  601.             Create Fileset        Create a fileset on the fly.
  602.             Delete FileSet        Delete a fileset.
  603.  
  604.             Create Fileset From Wins    Builds a new fileset containing all
  605.                                 currently open windows.
  606.             Open Entire Fileset            Opens all files in a specified fileset.
  607.             
  608.             Create Think Fileset Create a fileset containing the source files
  609.                                 of the current Symantec project.
  610.             Create Warrior Fileset Create a fileset containing the source files
  611.                                 of the current CodeWarrior project.
  612.  
  613.             Find Tag            Find a function definition.
  614.             Create Tag File        Create a "tag" file specifying where functions
  615.                                 are defined.
  616.  
  617.             Replace In Fileset    Global search-and-replace through a fileset. Does
  618.                                 not update open windows unless told to.
  619.                                 
  620.             Rebuild Fileset Menu    Rebuilds the menu. Filesets created with 
  621.                                 globbing (all except the Symantec and 
  622.                                 CodeWarrior filesets) are re-globbed and 
  623.                                 reflect changes in the directories.
  624.                                 
  625.     
  626.           Menus, User-Defined 
  627.  
  628. All of Alpha's menus are defined in the initialization files that Alpha 
  629. loads on startup.  They can be altered or discarded at well.  Alpha's menu 
  630. commands allow the the user to build custom menus which contain names of 
  631. functions, macros, or arbitary TCL commands that just HAVE to be in the 
  632. menus, as opposed to being merely callable through the bindings.  The 
  633. syntax is dead simple.  Menus can be nested, allowing heirachical menus to 
  634. be defined.  See the 'alphaBits.tcl' file for examples (only the first 
  635. three Alpha menus are hard-coded into the Application, the others are set 
  636. up through the alphaBits.tcl file).  The following meta characters can be 
  637. embedded in the strings:
  638.  
  639.    Meta-character     Usage
  640.    --------------     -----
  641.  
  642.     ; or Return       Separates multiple items.
  643.     ^                 Followed by an icon number, adds 
  644.                       that icon to the item.
  645.     !                 Followed by a character, marks the
  646.                       item with that character.
  647.     <                 Followed by B, I, U, O, E, or S,  
  648.                       sets the character style of the item.
  649.     /                 Followed by a character, sets up
  650.                       a keyboard equivalent.
  651.     (                 Disables the item.
  652.  
  653.  
  654. The following modifiers can be used to require other combinations of modifiers
  655. than just the command key. Control-option, for instance, is specified by 
  656. putting the string "<B<I" in the menu item. The menu symbol for shift is 
  657. an upward outline arrow, control is the outlined ^ symbol ("Files:Close All"
  658. has one), and option is the wavy line with the dot in the upper right 
  659. ("Wins:Iconify" has one). The following are characters that can follow 
  660. the '<' and what they signify.
  661.  
  662.     B        - control key required
  663.     I        - option key required
  664.     U        - shift key required (only for alpha-numerics!)
  665.     O        - command key required
  666.     S        - isDynamicItem is part of dynamic item.
  667.     E        - forces item to start new dynamic item.
  668.  
  669.  
  670. Please ignore the following:
  671.  
  672.     a    Enter            n    F10
  673.     b    Return            o    F11
  674.     c    Tab                p    F12    
  675.     d    Num Lock        q    F13
  676.     e    F1                r    F14
  677.     f    F2                s    F15
  678.     g    F3                t    Help
  679.     h    F4                u    Del
  680.     i    F5                v    Forward Del
  681.     j    F6                w    Home
  682.     k    F7                x    End
  683.     l    F8                y    Page Up
  684.     m    F9                z    Page Down
  685.     
  686.     128    Up                130    Left
  687.     129    Down            131    Right
  688.     
  689.  
  690.  
  691. The menu creation syntax is :
  692.  
  693.     menu [-s] <-n name> <-i num> [-p procName] [-m] "Tcl list of items"
  694.  
  695. Where the arguments have the followings meanings:
  696.   '-s'            Use system menu definition proc (faster).
  697.   '-i <num>'    Resource id of icon suite to use for menu title.
  698.   '-n <name>'    Name of menu.
  699.   '-m'            No menu form. If not supplied, each menu item is split into 
  700.                   words at each capitalized letter.
  701.   '-p <pname>'     Rather that having alpha call a Tcl proc named by the menu 
  702.                   item's text, this option tells Alpha to call the tcl proc 
  703.                   named by 'pname' with two arguments: the menu name, and the
  704.                   text of the menu item chosen.
  705.   '-M <mode>'    Bindings only take effect in specified mode.
  706.   
  707. Once the menus are created, they can be inserted and  deleted from the 
  708. menu bar by the syntax:
  709.  
  710.    insertMenu "name"
  711.    removeMenu "name"
  712.  
  713. as well as through macros.
  714.  
  715.  
  716. As alluded to above, Alpha attempts to make procedure names readable in the 
  717. menus by separating words at any capitalized letter. For example, 
  718. 'findFile' becomes "Find File". This function is turned off by the '-m' 
  719. option. 
  720.  
  721. Menu items can be enabled and disabled through the TCL command 
  722. 'enableMenuItem'. Menu items checkmarks can be turned on and off via 
  723. 'markMenuItem'. Menu items can be appended via 'addMenuItem' and deleted 
  724. via 'deleteMenuItem'. See the "Alpha Commands" help file for syntax. 
  725.  
  726. As explained above, the Mac ToolBox uses various keys to specify text 
  727. style and key equivalents. Sometimes you may want these characters 
  728. included in your text literally. If an ampersand ('&') is the last 
  729. character in a menu item, Alpha coerces the string so that these special 
  730. characters are not interpreted.
  731.  
  732. If an ellipsis ('╔') is the last character in a menu item (except possible 
  733. for the above ampersand), it is stripped off before searching for the 
  734. function corresponding to the chosen item.
  735.  
  736.  
  737. #================================================================================
  738. # Just for the heck of it, the following is a script that I put in my 
  739. # prefs.tcl file. It creates a menu for all the .tex files in my 
  740. # thesis directory, minus the dirname and .tex extension.
  741. #
  742. set THESIS "Internal:Textures:thesis"
  743. proc thesisMenuProc {menu item} {
  744.     global THESIS
  745.     edit -r -m $THESIS:$item.tex
  746. }
  747.  
  748. set files ""
  749. foreach f [glob $THESIS:*.tex] {
  750.     lappend files [file rootname [file tail $f]]
  751. }
  752. menu -n Thesis -m -p thesisMenuProc $files
  753. unset files
  754. #================================================================================
  755.  
  756.  
  757.  
  758.           TCL
  759.  
  760. See the Tcl manual page under the 'Help' menu for a complete description of 
  761. Tcl, the Tcl shell, and its commands.  Each of the Tcl commands and 
  762. several sections have a mark defined, so you can use the "Mark" menu to 
  763. navigate through the manual page.  
  764.  
  765.  
  766.  
  767.           Key Bindings
  768.  
  769. Any TCL command can be bound to any single keystroke. One way to bind a 
  770. function is with a statement such as:
  771.   
  772.       bind 'c' <modifier string> funcName [<mode>]
  773.           
  774. where c is a character, <modifier string> is an optional string containing 
  775. one or more of:
  776.  
  777.       c   - command modifier
  778.       o   - option modifier
  779.       s   - shift modifier
  780.       z   - control modifier
  781.       e   - escape modifier      
  782.  
  783. Additionally, the modifier string can contain a capital letter specifying 
  784. that the binding is only activated if preceded by control and the lowercase 
  785. version of that letter. This feature allows multiple-key combinations ala 
  786. Emacs. The following line binds cmd-shift-f to the function 'forwardChar': 
  787.  
  788.  bind 'f' <cs> forwardChar 
  789.  
  790. The next line would bind the same function to C-x C-f, assuming that 
  791. control-x is bound to the function 'prefixChar': 
  792.  
  793.  bind 'f' <cX> forwardChar 
  794.  
  795. 'mode' is an optional parameter that specifies, when present, that the 
  796. binding is only active in a given mode, where the current mode is the 
  797. parameter to the last call of 'displayMode' (look in "procs.tcl"). Note 
  798. that given a general binding (no mode specification) and a binding specific 
  799. to the current mode, the last binding to have been created is the one found 
  800. first. 
  801.  
  802. Additionally, most keyboards have keypads and/or Function Keys. These 
  803. keys can be bound using case-insensitive numeric labels using the same 
  804. bind command as above, with the label replacing the character. For 
  805. example, to bind F1 to function 'funcName', the following would work:
  806.  
  807.     bind F1 funcName
  808.  
  809. As above, the binding can include a modifier string. The following labels 
  810. are defined for US keyboards:
  811.  
  812.   Esc F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12 F13 F14 F15 Help Home Pgup Del 
  813.   End Pgdn Left Right Up Down Clear Kpad0 Kpad1 Kpad2 Kpad3 Kpad4 Kpad5
  814.   Kpad6 Kpad7 Kpad8 Kpad9 Kpad= Kpad/ Kpad* Kpad- Kpad+ Enter Kpad.
  815.  
  816. The function 'listBindings' will list all of the bindings currently in 
  817. effect in a format suitable for re-loading.
  818.  
  819. The above labels may not be sufficient for all keyboards (attention 
  820. international users). If a hex number is used instead of a character inside 
  821. the single quotes, the binding is done to key codes instead of ascii 
  822. values. The following is a key code version of the same binding: 
  823.  
  824.       bind 0x03 <cs> forwardChar
  825.  
  826. The key code for any given key can be obtained by using the 'keyCode' 
  827. function. 
  828.  
  829. Also, there is an alternate form that allows the specification of an 
  830. ascii code directly:
  831.  
  832.     ascii 0x20 <z> setMark
  833.     
  834. Binds control-space to 'setMark'.
  835.  
  836. Note that menu item command equivalents take precedence over bindings, 
  837. and that the 'bind' command does not affect the command equivalents 
  838. displayed in the menus. Command equivalents can only be changed by using
  839. an external tool like 'ResEdit'. Also note that key code bindings take 
  840. precedence over ascii bindings. 
  841.  
  842. Finally, there are 'unbind' and 'unascii' functions, with identical 
  843. arguments to their counterparts. 
  844.  
  845. <Shf Ctl> and <Shf Opt Cmd> have been reserved for user-defined
  846. keybindings.
  847.  
  848.  
  849.           Undo + Redo
  850.  
  851. ALPHA supports unlimited undo and redo. This means that most changes can 
  852. be undone, and then redone, at will. Bear in mind that once you create new 
  853. modifications, all changes that you have undone but not redone are lost. 
  854. Another point to bear in mind is that saving a buffer to disk currently 
  855. flushes the undo buffer. 
  856.  
  857.  
  858.           Event Hooks
  859.  
  860. Alpha calls the TCL procs "openHook", "saveHook", "saveasHook", "closeHook", 
  861. "activateHook", "deactivateHook", "suspendHook", and "resumeHook" when the 
  862. corresponding events occur. With the exception of "saveasHook", the proc 
  863. are all called with the complete pathname as the sole argument. 
  864. "saveasHook" is called with the old pathname as the first argument and the 
  865. new pathname as the second argument. Default implementations for these 
  866. commands are in the file 'modes.tcl'. These commands can be modified to 
  867. perform arbitrary commands, including saving of files, backups, 
  868. implementations of per-window variables, etc. 
  869.  
  870.           Tags
  871.  
  872. ALPHA supports the use of tags to find declarations of functions; by 
  873. default this is set up only for 'C'.  When searching for a tag, ALPHA looks 
  874. for the tag file specified by the "tagFile" string variable.  ALPHA's tag 
  875. generating routines use the regular expression in the string variable 
  876. "funcExpr" to look for function declarations.  In other words, we don't 
  877. parse the text.  If you declare your functions differently, you can change 
  878. " funcExpr" to suit your own style.  Alpha currently uses the following 
  879. regular expression to find C function declarations:
  880.  
  881.               ^[^ \t#\r/@][^\r]*\([^\r]*\)$
  882.  
  883. (NOTE: the above expressions won't pick up many C++ method definitions. To 
  884. pick them up, add a question mark '?' after the last right parenthesis.) 
  885. Although complicated, this expression makes sense if you slowly wade 
  886. through it. The string that we are looking for must take up an entire 
  887. line. It must begin with a character other than '\t', '#', '\r', '/', ' ', 
  888. or '@'. There must be a set of parenthesis.   
  889.  
  890. Note that not only can you customize this to your style of 'C' 
  891. declarations, you could also use it to generate tags for other languages. 
  892. The only thing you need to bear in mind is that the tag routines use the 
  893. complete word previous to the first '(' in the selected line as the 
  894. function's name. If there is no '(' in the selected line, the last word in 
  895. the line is used. Therefore, Pascal procedures w/ or w/o parameters can be 
  896. identified.
  897.  
  898. Caveat: Apple's list manager can't handle more than 32k of text in the 
  899. entire list, so there is a practical limit of 2000 or so tags in your 
  900. project.
  901.  
  902.  
  903.           Backups
  904.  
  905. If the 'backup' variable is set in preferences files, or from the 
  906. Utils:Flags menu, Alpha backs up each file before saving new 
  907. modifications. By default, the backup file is in the same directory, and 
  908. its name is formed by suffixing a tilde to the name of the saved file. 
  909. Backups are actually performed in the 'saveHook' proc (see above), in the 
  910. file procs.tcl. The Tcl variables 'backDir' and 'backExtension' can be 
  911. used to modify this behavior.
  912.  
  913.  
  914.           Fill Routines
  915.  
  916. The "fill" and "wrap" routines reformat text to specified line lengths. 
  917. This is useful in two case. First, word processors such as Microsoft Word 
  918. only insert carriage returns at the end of paragraphs. Secondly, while 
  919. typing and inserting text into pre-existing paragraphs, the line lengths 
  920. become unequal. 
  921.  
  922. The "wrap" routine handles word processor documents quickly by merely 
  923. inserting carriage returns as necessary to ensure all lines in the 
  924. selected region are shorter than specified by the variable 'fillColumn'. 
  925. Alpha asks the user if wrapping should be done whenever the user opens 
  926. files that have lines longer than 'paraColumn' characters. This feature 
  927. can be defeated by including the word 'nowrap' anywhere on the first line.
  928.  
  929. The TCL routines 'fillRegion' and 'fillParagraph' go further. Not only do 
  930. they break lines, but they also coalesce lines to eliminate short lines. 
  931. Both routines work by stripping the relevent text of white space, then 
  932. re-inserting white space and carriage returns so that no line extends past 
  933. 'fillColumn' characters in length and begins with 'leftFillColumn' spaces 
  934. characters. Both routines are implemented in the file 'procs.tcl', and 
  935. therefore different definitions of paragraphs can be accomodated by 
  936. modifying the appropriate TCL procedures.
  937.  
  938.  
  939.           Soft Text Wrapping
  940.           
  941. "Soft" text wrapping is re-formatting the rest of the paragraph on-the-fly 
  942. as text is inserted and deleted.  Soft-wrapping is enabled by selecting 
  943. "Toggle Soft Wrap" in the windows menu (or by hitting F10) for any mode that 
  944. enables the variable 'wrapText'.  By default, 'wrapText' is enabled in the 
  945. Text and TeX modes.  The text to be wrapped is delimited by the current 
  946. line and the last line in the current paragraph.  Wrapping occurs after 
  947. insertions that result in the current line becoming longer than 'wrapHigh' 
  948. characters long (tabs counted as one character), or deletions where the 
  949. length of the line (tabs likewise) becomes less than 'wrapLow' characters 
  950. long.
  951.  
  952.  
  953.           Word Breaking
  954.  
  955. Alpha allows you to redefine its internal notion of what a word is, 
  956. through the variables 'wordBreak', and 'wordBreakPreface'. 'wordBreak' is 
  957. set to a regular expression that defines a word to you. 'wordBreakPreface' 
  958. should be a regular expression that matches exactly one of any characters 
  959. that are not in your word definition. 
  960.  
  961. For instance, the default definition of 'wordBreak' is '[a-zA-Z0-9_]+'. 
  962. This matches any contiguous sequence of contiguous alphanumeric 
  963. characters, plus underscore.
  964.  
  965. The default value for wordBreakPreface is '[^a-zA-Z0-9_]', basically just 
  966. the negation of any any of the characters in your 'wordBreak' definition. 
  967.  
  968. The need for both these variables in backward searches can be seen as 
  969. follows. Suppose your window's text is "hey hello", and the current 
  970. insertion is between the two 'l's. Now, searching backwards for the above 
  971. 'wordBreak' definition will take the insertion to between the 'e' and the 
  972. first 'l', not really where we want to say is the start of the word. By 
  973. contrast, if we search backwards for 'wordBreak' and 'wordBreakPreface' 
  974. concatenated together, and then move forward one character after a 
  975. successful search, we end up right before the 'h' in 'hello', just where 
  976. we want to be.
  977.  
  978.  
  979.           File Sets
  980.  
  981. File Sets are lists of files that Alpha uses for multiple-file searches and 
  982. tag searches, among other things.  Typically, a user will set up several 
  983. different file sets, perhaps one specifying all the source files in a 
  984. project, another specifying all the Mac include files, and another 
  985. specifying all the UNIX include files.  When a command using file sets is 
  986. initiated, Alpha evaluates the command "getCurrFileSet", which returns a 
  987. list of complete pathnames to search.
  988.  
  989. Functions that use file sets operate on the "current" fileset, which is 
  990. specified by the 'fileSet' variable. The current file set can also be 
  991. switched by using  the "File Set" heirarchical menu. 
  992.  
  993.  
  994.           Macros, Keyboard
  995.  
  996. Defining and Using Keyboard Macros ALPHA supports keyboard macros which 
  997. record a sequence of keystrokes to be played back later w/ the function 
  998. 'executeKeyboardMacro' (this function is also in the 'Utilities' menu) or 
  999. written into a buffer by selecting 'Dump Macro' from the 'Utilities' menu. 
  1000. The dump function prompts you for a macro name, which must consist only of 
  1001. letters of the alphabet, digits, and '_'. 
  1002.  
  1003. These macro declarations can then be edited, loaded, and bound to 
  1004. keystrokes.  Loading a macro or a binding is accomplished by hiliting the 
  1005. text and selecting the "Load" item of the 'Edit' menu.  If no text is 
  1006. hilited, the entire window is loaded by the same command.  Macros can be 
  1007. bound to keys in exactly the same manner as functions (see above).
  1008.  
  1009.  
  1010.           THINK and Alpha
  1011.  
  1012. Yes! Finally Think has support for external editors (7.0 or better).  To 
  1013. make this work, put an alias of Alpha in the "Tools" subdirectory of the 
  1014. directory the project manager is in, and name the alias "Editor".  
  1015. Secondly, check the "Use External Editor" button in the project manager's 
  1016. option dialog.  You do not have to check the "Always Check File Dates" 
  1017. button.
  1018.  
  1019. Any open window events will now be vectored to Alpha, and from within 
  1020. Alpha you can initiate compiles, disassembles, makes, etc. Errors are 
  1021. reported back to Alpha.
  1022.  
  1023. Look in :Tcl:SystemCode:"think.tcl" for the code controlling much of the 
  1024. interactions between THINK and Alpha.  If you improve anything, please send 
  1025. it back to me.
  1026.  
  1027. If a window contains a file that is part of the a project that is 
  1028. currently open in the Think Project Manager, selecting "Open Header" from 
  1029. the Think menu will put up a list of include files. The same files can be 
  1030. accessed by option-clicking on the window's title-bar.
  1031.  
  1032. A fileset consisting of the source to a think project can be created 
  1033. through the "File:File Sets" menu.
  1034.  
  1035.  
  1036.           Rectangular Editing
  1037.  
  1038. If the option key is pressed while the mouse is dragged,  a rectangular 
  1039. section of text is selected instead of the normal selection. This 
  1040. rectangular selection may extend over multiple lines, but contains only 
  1041. text between the column of the drag start and the column of the drag end. 
  1042. The drag cannot end on a column or row less than the start. This selection 
  1043. can be extended by option-shift-mouse, but not dragged further.
  1044.  
  1045. The rectangular selection can be deleted, copied, and pasted. This is very 
  1046. useful for tables and arrays, such as in LaTeX. Usually, the operation 
  1047. will be intuitive. However, if you use proportional fonts the selection 
  1048. may appear ragged. If some of the line contain tabs, the result may not be 
  1049. want you want. Converting tabs to spaces in the desired region before 
  1050. attempting rectangular selection usually fixes the problems. 
  1051.  
  1052. The most natural semantics of rectangular selection aren't obvious. I 
  1053. chose to implement it in a similar fashion to that of Microsoft Word. 
  1054. Preditor does it in another way, and has many bugs (and it's  commercial, 
  1055. hah!).
  1056.  
  1057.  
  1058.  
  1059.           LaTeX
  1060.  
  1061. See the "LaTeX Help" file under the help menu.
  1062.  
  1063.  
  1064.  
  1065.  
  1066.           System Software 7.0
  1067.  
  1068. Alpha is 32-bit clean and high-level event aware. 
  1069.  
  1070. Under 7.0, Alpha uses temporary memory to accommodate large files. This 
  1071. allows you to open multi-megabyte files even when Alpha's partition is set 
  1072. only at 512k, if the system has that much memory available. Note that 
  1073. using temporary memory makes that much memory unavailable to other 
  1074. applications. Contrary to all admonishments, Alpha does not unlock 
  1075. temporary memory across WaitNextEvent calls and may eventually use all the 
  1076. memory in your system. You can turn this feature off through 'tempMem'.
  1077.  
  1078. Note, however, that the clipboard is allocated by the system in Alpha's 
  1079. heap, and therefore cannot take advantage of temporary memory.
  1080.  
  1081.  
  1082.  
  1083.  
  1084.           Apple Events
  1085.  
  1086. See the Help file on AppleEvents.
  1087.  
  1088.  
  1089.           MPW
  1090.  
  1091. Alpha's 'dosc' capability (see the function "dosc") can be used to send 
  1092. events to MPW's ToolServer. Using about ten lines of C code and the ~40 
  1093. lines of Tcl code in 'mpw.tcl', I created a pseudo mpw shell (look under 
  1094. the "Misc" menu). This shell uses Alpha's 'dosc' function to package each 
  1095. shell command up into an Apple Event and send it to the ToolServer, which 
  1096. then evaluates the command and returns the result to be displayed in the 
  1097. shell. I'm rather new to Apple Events and the ToolServer, so there are 
  1098. probably a few rough edges. 
  1099.  
  1100. If anyone has extensive docs for ToolServer I'd appreciate looking at them. 
  1101. I only have the application because I am a beta tester for another product 
  1102. that supports ToolServer. I was given the application for the beta testing, 
  1103. but not any docs. And of course, I can *not* give away copies of 
  1104. ToolServer because it is a licensed Apple product.
  1105.  
  1106. Finally, Tom Moertel (thor@vivaldi.psu.edu) has written and provided a set 
  1107. of tools that make life easier while writing code in Alpha for the MPW 
  1108. environment. The tools make extensive use of Apple Events, so you must be 
  1109. using MPW 3.3a or greater. (Earlier versions cannot receive commands via 
  1110. Apple Events.) 
  1111.  
  1112.   With the MPW-Alpha package you can:
  1113.   
  1114.     o  Send TCL commands to Alpha from MPW
  1115.     o  Use MPW 411 from Alpha for instant access to programming help
  1116.     o  Automagically locate source code errors from your last MPW compile
  1117.     o  Use the MPW CDent tool to reformat (grind) C/C++ source code
  1118.        from within Alpha
  1119.  
  1120. This package is available via anonymous ftp from cs.umd.edu.
  1121.  
  1122.  
  1123.           File Formats
  1124.  
  1125. Alpha reads and writes files stored in three (or maybe four) different 
  1126. formats. The three main formats are mac (lines end with a carriage 
  1127. return), unix (lines end with linefeed), and IBM pc (lines end with both 
  1128. carriage return and linefeed. Typical, isn't it?).
  1129.  
  1130. Alpha will transparently read and write all three of these formats. You 
  1131. don't have to do anything special to use different formats, but the 
  1132. 'SaveAs...' dialog allows you to specify the format that a file is written 
  1133. in through the 'Format' button.
  1134.  
  1135. The fourth file format is just a modification of the ordinary mac format. 
  1136. Word processors such as Microsoft Word and MacWrite only put carriage 
  1137. returns at the end of paragraphs, so that they can wrap  the paragraphs on 
  1138. the fly. This is what is referred to as 'paragraph format' in the rest of 
  1139. the help text. Alpha does not transparently convert to and from this 
  1140. format because there are valid reasons why someone might want to edit a 
  1141. paragraph formatted file while not in paragraph mode. 
  1142.  
  1143. Therefore, when Alpha detects reads a paragraph-mode file, it asks the 
  1144. user whether or not to remap it. Files can be mapped back to paragraph 
  1145. mode by setting 'fillColumn' to a very large number and executing 
  1146. 'fillRegion' on the text.
  1147.  
  1148.           Printing
  1149.  
  1150. Version 6.0 and above have many printing options available. Printing is 
  1151. accomplished via a submenu under the File menu. The menus allows printing 
  1152. either via Alpha or several other applications.
  1153.  
  1154. If printing through alpha, the variables 'printHeader', 'printHeaderTime', 
  1155. and 'printHeaderFullPath' control whether and what type of header is 
  1156. printed at the top of each page.  These flags are actually used in the proc 
  1157. printHeaderProc to create the string that appears on the left side of the 
  1158. top of the page.  'leftMargin', 'topMargin', and 'bottomMargin' control 
  1159. margins on the printed page.
  1160.  
  1161. 'printerFont' and 'printerFontSize' allows the size and type of the 
  1162. printed font to be specified.
  1163.  
  1164. The external apps that Alpha is currently configured to use are 
  1165. "Enscriptor", an app that allows multi-column and other options, "Kodex", 
  1166. a "C" pretty printer, and "DropÑPS", which prints postscript files. All 
  1167. options operate on the frontmost window. These applications are not 
  1168. supplied w/ Alpha, but can be downloaded from any comprehensive mac site. 
  1169. They can also be downloaded from Alpha's home site. "Enscriptor" and 
  1170. "Kodex" are shareware apps written by John Cho. "DropÑPS" is a freeware 
  1171. app written by some evil commercial text editor guru :-).
  1172.  
  1173.  
  1174.           Random Tips
  1175.  
  1176. - When a window is "dirty" (has unsaved changes), a
  1177.   red disk icon appears just below the titlebar in the
  1178.   upper right corner of the window, and a diamond 
  1179.   appears next to the corresponding item in the Windows
  1180.   menu. 
  1181.  
  1182. - All dialogs that have editable text can use the Cut, 
  1183.   Copy, and Paste menu command equivalents.
  1184.  
  1185. - In all dialogs, non-editable controls can be selected 
  1186.   by typing Command-<first char of control>. If there 
  1187.   are no editable controls in the dialog, simply typing 
  1188.   the first letter of the desired control suffices. PgUp,
  1189.   PgDown, Home, and End keys now work for most list dialogs.
  1190.  
  1191. - Set the flag 'undoOn' to 0 in order to speed up long 
  1192.   replace-all and macro modifications.
  1193.  
  1194. - After a piece of text has been yank'd or paste'd, the 
  1195.   'mark' is set to the beginning of the new text and the
  1196.   selection is at the end. 'markHilite' will now hilite 
  1197.   the entire insertion. This is especially useful when
  1198.   moving code. Cut the code, insert at a new position,
  1199.   select the inserted text by selecting "Edit:Hilite", and 
  1200.   then use "Edit:Shift Left" and "Edit: Shift Right" to move
  1201.   the text to the proper indentation.
  1202.  
  1203. - Most help files have marks in them, which let you quickly
  1204.   navigate to places of interest. You can access these marks
  1205.   by command-clicking on the title-bar or on the "{}" icon
  1206.   above the vertical scrollbar.
  1207.  
  1208.  
  1209.  
  1210.           Variables 
  1211.  
  1212. There are two different kinds of variables in the Alpha world: global 
  1213. vars and mode vars. Mode vars can have different values in each mode, and 
  1214. are modified by the "Mode Vars" popup menu over the checkmark just 
  1215. above vertical scrollbar. Changing one of these variables changes the 
  1216. variable's value for all windows of the current mode.
  1217.  
  1218. Global variables are accessed via the "Config:Flags" and "Config:Vars" menus. 
  1219. Changing one of these variables affects all windows.
  1220.  
  1221. Alpha records which variables are modified in the course of a session and 
  1222. prompts the user to save them prior to quitting.
  1223.  
  1224.  
  1225. Mode Vars
  1226.  
  1227. autoMark       Ñ Automatically mark windows on open if they don't have marks.
  1228. elecLBrace     Ñ Electric 'C' left brace on.
  1229. elecRBrace     Ñ Electric 'C' right brace on.
  1230. electricSemi   Ñ Electric 'C' semicolon on.
  1231. fillColumn     Ñ Number of columns use as limit for
  1232.                  "fill" routines. See 'leftFillColumn'
  1233. funcExpr       Ñ Set to the regular expression that 
  1234.                  ALPHA uses to find function 
  1235.                  declarations.
  1236. leftFillColumn Ñ Number of blanks left at beginning of 
  1237.                  lines by 'fill' routines. 
  1238. wordBreak       Ñ Regular expression used to defines words for all internal 
  1239.                  operations. 
  1240. wordBreakPreface Ñ Prepended to 'wordBreak' when looking backwards for a 
  1241.                  word. See the "Word Break" section of this file for more 
  1242.                  information.
  1243. wordWrap       Ñ if true, lines exceeding 'fillColumn'
  1244.                  in length are automatically wrapped
  1245.                  during normal text insertion (typing)
  1246. wrapBreak       Ñ Reg expr used for automatic word wrapping.
  1247. wrapBreakPreface Ñ Reg expr used for automatic word wrapping.
  1248. Global Vars
  1249. autoHScroll       Ñ Automatically scroll horizontal scrollbar
  1250.                  to follow insertion.
  1251. autoSave       Ñ If TRUE, buffers (except untitled buffers) are automatically
  1252.                  saved every 'changesLim' changes.
  1253. backDir           Ñ Directory in which to store backup files.
  1254. backExtension  Ñ Suffix to append to backup files.
  1255. backup         Ñ if TRUE, the default Tcl proc 'saveHook' makes a backup 
  1256.                  of a file before the data is written. The default backup
  1257.                  scheme has extension "~".
  1258. blinkCursor    Ñ Cursor blinks
  1259. blockCursor    Ñ if true, Alpha uses a block cursor instead of a vertical 
  1260.                  line. 
  1261. bottomMargin   Ñ Bottom print margin.
  1262. bwWindows      Ñ if true, Alpha will use 1-bit windows
  1263.                  even if color is available. This speeds
  1264.                  refresh quite a bit on slow color 
  1265.                  machines such as the IIsi.
  1266. changesLim     Ñ number of changes to a window before 
  1267.                  garbage collection or autosave is done.
  1268. coloring       Ñ enable keyword coloring.
  1269. def{Height,Left,Top,Width} Ñ If 'fullScreen' set, default size
  1270.                  of windows.
  1271. defaultFont    Ñ font to use on new windows and files 
  1272.                  which don't have associated font 
  1273.                  specification resources.
  1274. diffFlags       Ñ Command line args to pass to GNU diff.
  1275. dragAndDrop       Ñ Enable drag and drop.
  1276. fontSize       Ñ Default size of fonts used to display 
  1277.                  files.
  1278. forceMainScreenÑ If true, forces windows to main screen. Useful if you 
  1279.                  have a small screen and windows habitually are too large.
  1280. fullNames      Ñ Windows display pathnames instead of 
  1281.                  mere file names.
  1282. fullScreen     Ñ If on, all windows are start in the 
  1283.                  same place, and have the dimension 
  1284.                  specified by 'defHeight' and 
  1285.                  'defWidth'.
  1286. horScrollBar   Ñ If set, use horizontal scrollbar.
  1287. iconifyOnSwitchÑ Iconify all windows when suspending.
  1288. indentOnCR     Ñ Auto-indent on carriage return.
  1289. infoWindowsDirtyÑ Dirty/Clean state of description windows.
  1290. intelCutPaste  Ñ Enable intelligent cut and paste.
  1291. lockStatus       Ñ Disable status window dragging.
  1292. maskCapsLock   Ñ Mask caps lock bit on key depresses.
  1293. moveInsertion  Ñ if true, 'pageBack' and 'pageForward'
  1294.                  move the insertion point
  1295. numWinsToTile  Ñ specifies the number of windows tile
  1296.                  commands should affect.
  1297. paraColumn     Ñ Alpha automatically wraps files
  1298.                 that contains lines longer than this. 
  1299. posActivate    Ñ If true, then merely moving the mouse
  1300.                  over a window activates. For those
  1301.                  X11-twm lovers.
  1302. powerThumb       Ñ If true, vertical scrollbars have power thumbs.
  1303. printerFont       Ñ Font to print documents.
  1304. printerFontSizeÑ Size to print documents.
  1305. projectorAware Ñ Respect projector resources.
  1306. savedState       Ñ set to either "mpw", "think", or "none" depending on how 
  1307.                  much information you wish Alpha to save in the resource 
  1308.                  fork of the files you edit. See the "Files" section of 
  1309.                  this file for more information.
  1310. showInvisibles Ñ Show spaces, tabs, crs.
  1311. showRowCol     Ñ if set, row and col are continuously
  1312.                  displayed in the title bar. 
  1313. sortColumn     Ñ column to use for sort routine.
  1314. sortedIsDefaultÑ if set, sorted is the default for 
  1315.                  function and section menus.
  1316. suppressHeader Ñ Suppress header on printed pages.
  1317. tagFile        Ñ complete path-name of tag file
  1318. tile{Height,Left,Top,Width} Ñ rectangle to tile windows
  1319.                  within.
  1320. tempMem        Ñ Enable use of system temporary memory.
  1321. undoOn         Ñ used to turn undo on and off. When undo
  1322.                  is turned off, all undo info is lost.
  1323.                  Useful when doing global replaces, etc.
  1324. wrapHigh       Ñ Line length limit beyond which soft-wrapping occurs, if 
  1325.                  enabled.
  1326. wrapLow           Ñ      ""            ""
  1327.  
  1328.  
  1329.           Spellchecking
  1330.  
  1331. Alpha has the capability to interact with the spell-check 'Excalibur', 
  1332. written by Robert Gottshall and Rick Zaccone.  The menu item 'Spellcheck 
  1333. Window' is always available in the "Utils" menu.  Selecting this item will 
  1334. start up Excalibur and send an OpenDoc event describing the current window.  
  1335. For version 1.4 and earlier, if Alpha has to launch Excalibur you will need 
  1336. to dismiss Excalibur's opening dialog by hitting the Cancel button.  
  1337. Subsequent selections of the menu item will switch right into Excalibur 
  1338. with the correct file displayed.  In future versions, this will become even 
  1339. more automatic.
  1340.  
  1341. Excalibur is free, but not in the public domain.  It can be obtained from 
  1342. all the usual Internet ftp sites, as well as cs.umd.edu under 
  1343. pub/faculty/keleher/Alpha.
  1344.  
  1345.  
  1346.           International Users
  1347.  
  1348. Everything should work. If it doesn't, please tell me.
  1349.  
  1350.  
  1351.  
  1352.           Drag and Drop
  1353.  
  1354. Alpha supports drag and drop cut, copy, clear, and paste. To use this 
  1355. feature, select some text, then move the cursor over the selected text. 
  1356. The cursor should then turn into an open hand. Mouse down, and move the 
  1357. cursor to the place you wish to paste the text. When the mouse is 
  1358. released, the hilited text is moved to the new location.
  1359.  
  1360. Option-mouse does a "copy" instead. You can also drag selections between 
  1361. windows and to and from other applications, including the finder. Text 
  1362. can be deleted by dragging it to the trash can. 
  1363.  
  1364. You MUST have Apple's "Macintosh Drag And Drop" installed. Get a copy from Apple 
  1365. or via Alpha's web page.
  1366.  
  1367.  
  1368.  
  1369.           Status Bar
  1370.  
  1371. The stripe across the bottom of the screen is a floating window that 
  1372. displays status information, certain prompts (option-x, and see the func 
  1373. 'statusPrompt'), and the current row and column.
  1374.  
  1375. You can't make this window go away. However, both 'sizeWin' and 'moveWin' 
  1376. accept "StatusWin" as a window specification and will act on this window, 
  1377. so you can move the window offscreen if you really wish. The height
  1378. parameter to 'sizeWin' is ignored.
  1379.  
  1380. The status bar can be dragged if the flag 'lockStatus' is turned off.
  1381.  
  1382. Clicking over the row and column indicators allows you to jump to a 
  1383. particular line.
  1384.  
  1385. The left-most popup menu allows you to choose between simple wrapping when 
  1386. typing 
  1387.  
  1388. The left-most popup menu is the "File Flags" menu.  The next icon is the 
  1389. "Mode" popup menu, which shows the window's current mode and allows it to 
  1390. be changed.
  1391.  
  1392. Finally, if you turn horizontal scrollbars off (via the 'horScrollBar' 
  1393. flag in the "Config:Flags" menu, you haven't lost any real estate. 
  1394. Furthermore, when tiling windows vertically, you actually have *more* 
  1395. real estate. 
  1396.  
  1397.  
  1398.           Modes
  1399.  
  1400. Each window in Alpha is always in a single "mode", such as the "C++" mode, 
  1401. or the "TeX" mode.  A mode describes bindings and variable values 
  1402. particular to that mode.  The mode of the frontmost window is displayed and 
  1403. can be changed via the status bar.
  1404.  
  1405. Alpha sets modes for new windows based on file name suffixes.  For instance, 
  1406. "files.c" is started up in mode "C" because of the ".c" suffix.  Below 
  1407. are the standard suffixes recognized by Alpha. You can add more suffixes 
  1408. in your prefs.tcl file by duplicating the lines adding these suffixes 
  1409. in :Tcl:SystemCode:modes.tcl. The default mode is "Text".
  1410.  
  1411.     .h, .c, .r                        C
  1412.     .cc, .cp, .cpp, .CPP, .C        C++
  1413.     .f .fcm .for .FOR                Fort
  1414.     .tcl                            Tcl
  1415.     .tex, .sty, .ltx, .dtx, .ins    TeX
  1416.     .pl                                Perl
  1417.     .html .HTML                        HTML
  1418.     
  1419. Bindings for a specific mode can be specified by passing the desired mode 
  1420. as the last argument to a 'bind' command (see "Key Bindings"). 
  1421.  
  1422. Alpha has two different types of immediately visible flags and variables. 
  1423. "Global" variables don't change from mode to mode. These are listed in 
  1424. "Modes:Flags" and "Modes:Vars". Any change there affects 
  1425. every mode.
  1426.  
  1427. "Mode" flags and variables are instantiated separately for each mode.  
  1428. These are inspected and set via the "Config:Current Mode" menu.  Changing 
  1429. these values affects every window in that mode, but doesn't affect windows 
  1430. in other modes.
  1431.  
  1432. The variables displayed in "Config:Current Mode" are all the variables that the 
  1433. current mode cares about.  The "Set Mode Menus╔" item allows you to specify 
  1434. which of the extra menus should be present whenever the frontmost window is 
  1435. in that mode.  Select multiple menus by shift-clicking.
  1436.  
  1437.  
  1438.  
  1439.           File Comparison
  1440.  
  1441. Version 5.94 and above can create UNIX "diffs" of two text files. Among 
  1442. other things, diffs allow you to easily pinpoint what has changed between 
  1443. two different versions of the same file. 
  1444.  
  1445. Alpha's interface (under the "Utils" menu) allows you to compare either 
  1446. the two topmost windows, or two arbitrary files (later, Alpha will be 
  1447. able to compare entire directories). Alpha opens the two files in windows 
  1448. at the top of the screen with the diff file at the bottom. You can 
  1449. navigate between individual differences in the diff file by using the Up 
  1450. and Down arrows. Pressing either a carriage return or the Enter key 
  1451. displays the affected portions of the two files in the above windows.
  1452.  
  1453. I'm currently using a hack of QUED's GNU diff port.  My hack allows 
  1454. it to work as an AppleEvent server.  However, it handles most errors by 
  1455. quitting without responding, and handles only a single message before 
  1456. quitting. It also doesn't deal with directories. 
  1457.  
  1458. The interface is a 'dosc' script event containing the command-line 
  1459. arguments that would be used in running 'diff' from a UNIX shell (see 
  1460. here).  The result is the diff.  On the command line, file names containing 
  1461. spaces can be specified by delimiting the entire file name with double 
  1462. quotes.  The source for my version of the diff application (crude though it 
  1463. is), is available in pub/faculty/keleher/Alpha on cs.umd.edu.
  1464.  
  1465. Bugs: The files must have line Mac terminations.
  1466.  
  1467.  
  1468.  
  1469.           HyperText
  1470.  
  1471. Alpha's hypertext is both more and less powerful than systems that use 
  1472. markup languages such as HTML. It's more powerful because the action 
  1473. taken upon hitting a hypertext link is any arbitrary Tcl script rather 
  1474. than just navigation. It's less powerful because the generality doesn't 
  1475. allow a standard notion of going "back" or "forward". In any case, two 
  1476. points:
  1477.     1) The hypertext is only intended for Alpha documentation, and links 
  1478.     should not need to be created by anyone who isn't writing docs.
  1479.     
  1480.     2) 'pushMark' is called before any hypertext link is executed. This 
  1481.        allows you to return to the previous spot by "Pop Mark"ing (from the 
  1482.        Edit menu).
  1483.     
  1484. If you *must* create hypertext links, use the insertColorEscape command.
  1485.  
  1486.  
  1487.  
  1488.           Limitations
  1489.  
  1490. - Apple's listproc seems to have a total size limit of 32k characters. 
  1491.   This effectively limits tag searches to about 4000 function names.
  1492.  
  1493.  
  1494.           Preferences
  1495.  
  1496. Alpha saves settings between sessions by writing them to files in an 
  1497. "Alpha" sub-folder of the system preferences folder.  Additionally, Alpha 
  1498. will source a file called "prefs.tcl" from this sub-folder if it exists.  
  1499. You can view or remove the settings currently being saved there at any time 
  1500. via the "View/Remove Saved Settings╔" from the Edit menu. You can edit 
  1501. the prefs.tcl file via the "Edit prefs.tcl" item. 
  1502.  
  1503. Never add manually add text to the defs.tcl or arrdefs.tcl files in the 
  1504. preferences folder. These files are automatically generated and read by 
  1505. the addDef etc. functions. If you need to save variable definition from 
  1506. Tcl code, addDef etc. is your friend. 
  1507.  
  1508. If you want to have arbitary code executed on startup, you can manually 
  1509. place this in the prefs.tcl file.
  1510.  
  1511.  
  1512.  
  1513.           Changing Alpha's Behavior
  1514.  
  1515. Alpha's behavior can be modified in four primary ways.  The first is by 
  1516. changing flag and variable values.  Mode-independent flags and variables 
  1517. are under the "Config:Flags" menu.  Mode-dependent flags and variables are 
  1518. in "Config:Current Mode".  Values of all of these flags and variables are 
  1519. saved when Alpha exits.
  1520.  
  1521. The second method is to add bindings or Tcl procs to 'prefs.tcl', Alpha's 
  1522. preference file.  This file is accessible from the "Config" menu as well.  
  1523. 'prefs.tcl' is sourced at the end of Alpha's startup procedure.
  1524.  
  1525. The third way to modify Alpha's behavior is to create mode-specific prefs 
  1526. files. These files are created through the Config menu. Mode-specific prefs 
  1527. are loaded after the corresponding mode has been entered for the first 
  1528. time.
  1529.  
  1530. The final recomended way to modify Alpha is to create files that are 
  1531. sourced after corresponding files in Alpha's :Tcl:SystemCode directory. See 
  1532. here for more details.
  1533.  
  1534. Finally, you could just hack the files in SystemCode directly. However, 
  1535. you should definitely know what you are doing if you resort to this method, 
  1536. and it's definitely *not* portable from one version of Alpha to the next.
  1537.  
  1538.  
  1539.  
  1540.           HTML
  1541.  
  1542. See here.
  1543.  
  1544.  
  1545.  
  1546.           Internet Config
  1547.  
  1548. "Internet Config" is a freeware utility that holds system-wide preferences, 
  1549. especially preferences that might be accessed by more than one 
  1550. application.  For example, Internet Config stores pointers to helpers for 
  1551. web services, ftp, etc.  
  1552.  
  1553. Alpha supports "Internet Config" in the following ways: (i) 
  1554. command-clicking on highlighted text causes the text to be sent to Internet 
  1555. Config to be launched, (ii) the Internet Config menu allows either Internet 
  1556. Config itself, or several of it's internet helpers, to be started, and iii) 
  1557. Alpha can query internet config for path names in the "Config:App Paths" 
  1558. dialog. 
  1559.  
  1560. Click here for more information.  Once you have installed it and set up 
  1561. your ftp helper app through Internet Config, you can retrieve the entire 
  1562. package by clicking here.
  1563.  
  1564.  
  1565.  
  1566.           Templates
  1567.  
  1568. Temporary marks can also be used to with language construct templates. The 
  1569. file "template.tcl" contains an example implementing a template for C's 
  1570. 'for' command. Depressing control-i will insert a template for the "for" 
  1571. command into the current window. Five temporary marks are defined in the 
  1572. for structure, three inside the parenthesis, one where the "for" body text 
  1573. will be inserted, and one after outside the for body entirely. Depressing 
  1574. control-shift-i moves the cursor to the next of the five temporary marks 
  1575. allowing quick entry of the entire command.
  1576.  
  1577.